API Documentation
StructToString.h
1 // StructToString.h
3 //
5 
6 namespace nkGraphics
7 {
13  class DLL_GRAPHICS_EXPORT StructToString
14  {
15  public :
16 
17  // Shader types
32 
33  // Shader semantics
48 
49  // Program profile
64 
65  // Blend
72  static const char* getBlendString (BLEND val) ;
86  static BLEND getBlendFromIndex (unsigned int index) ;
87 
88  // Blend Op
109  static BLEND_OP getBlendOpFromIndex (unsigned int index) ;
110 
111  // Write mask
132  static COLOR_WRITE_ENABLE getWriteMaskFromIndex (unsigned int index) ;
133 
134  // Comparison func
155  static COMPARISON_FUNC getComparisonFuncFromIndex (unsigned int index) ;
156 
157  // Depth write mask
178  static DEPTH_WRITE_MASK getDepthWriteMaskFromIndex (unsigned int index) ;
179 
180  // Stencil op
201  static STENCIL_OP getStencilOpFromIndex (unsigned int index) ;
202 
203  // Fill mode
224  static FILL_MODE getFillModeFromIndex (unsigned int index) ;
225 
226  // Cull Mode
247  static CULL_MODE getCullModeFromIndex (unsigned int index) ;
248 
249  // Address Mode
270  static TEXTURE_ADDRESS_MODE getAddressModeFromIndex (unsigned int index) ;
271 
272  // Filter
293  static FILTER getFilteringFromIndex (unsigned int index) ;
294 
295  // Usage
316  static USAGE getUsageFromIndex (unsigned int index) ;
317 
318  // Format
339  static FORMAT getFormatFromIndex (unsigned int index) ;
340 
341  // Bind Flag
362  static BIND_FLAG getBindFlagFromIndex (unsigned int index) ;
363 
364  // CPU Access Flag
385  static CPU_ACCESS_FLAG getCpuAccessFlagFromIndex (unsigned int index) ;
386 
387  // Misc Flags
408  static RESOURCE_MISC_FLAG getMiscFlagFromIndex (unsigned int index) ;
409 
410  // Pass type
425 
426  // Resource type
441 
442  // Texture render flag
457  } ;
458 }
nkGraphics::CULL_MODE
CULL_MODE
Available culling modes.
Definition: DxDefinesWrapper.h:450
nkGraphics::RESOURCE_MISC_FLAG
RESOURCE_MISC_FLAG
Available misc flags for resources.
Definition: DxDefinesWrapper.h:56
nkGraphics::StructToString::getStringComparisonFunc
static COMPARISON_FUNC getStringComparisonFunc(const nkMemory::StringView &str)
nkGraphics::BLEND_OP
BLEND_OP
Available blending operations.
Definition: DxDefinesWrapper.h:414
nkGraphics::StructToString::getFormatString
static nkMemory::StringView getFormatString(FORMAT val)
nkGraphics::StructToString::getCullModeString
static nkMemory::StringView getCullModeString(CULL_MODE val)
nkGraphics::StructToString::getStringWriteMask
static COLOR_WRITE_ENABLE getStringWriteMask(const nkMemory::StringView &str)
nkGraphics::StructToString::getDepthWriteMaskFromIndex
static DEPTH_WRITE_MASK getDepthWriteMaskFromIndex(unsigned int index)
nkGraphics::StructToString::getStringResourceType
static RESOURCE_TYPE getStringResourceType(const nkMemory::StringView &str)
nkGraphics::StructToString::getStringProgramProfile
static PROGRAM_COMPILATION_PROFILE getStringProgramProfile(const nkMemory::StringView &str)
nkGraphics::RESOURCE_TYPE
RESOURCE_TYPE
The type of resources available in the component.
Definition: ResourceType.h:12
nkGraphics::StructToString::getBindFlagString
static nkMemory::StringView getBindFlagString(BIND_FLAG val)
nkGraphics::SHADER_TYPE
SHADER_TYPE
Available shader types.
Definition: DxDefinesWrapper.h:461
nkGraphics::BIND_FLAG
BIND_FLAG
Available binding flags for a resources.
Definition: DxDefinesWrapper.h:25
nkGraphics::StructToString::getPassTypeString
static nkMemory::StringView getPassTypeString(PASS_TYPE val)
nkGraphics::StructToString
Converts enums to string, and vice versa.
Definition: StructToString.h:14
nkGraphics::StructToString::getStencilOpFromIndex
static STENCIL_OP getStencilOpFromIndex(unsigned int index)
nkGraphics::StructToString::getShaderTypeString
static nkMemory::StringView getShaderTypeString(SHADER_TYPE val)
nkGraphics::StructToString::getBlendOpString
static nkMemory::StringView getBlendOpString(BLEND_OP val)
nkGraphics::StructToString::getStringBlend
static BLEND getStringBlend(const nkMemory::StringView &str)
nkGraphics::StructToString::getComparisonFuncFromIndex
static COMPARISON_FUNC getComparisonFuncFromIndex(unsigned int index)
nkGraphics::StructToString::getStringShaderType
static SHADER_TYPE getStringShaderType(const nkMemory::StringView &str)
nkGraphics::StructToString::getStringPassType
static PASS_TYPE getStringPassType(const nkMemory::StringView &str)
nkGraphics::StructToString::getStringUsage
static USAGE getStringUsage(const nkMemory::StringView &str)
nkGraphics::StructToString::getResourceTypeString
static nkMemory::StringView getResourceTypeString(RESOURCE_TYPE val)
nkGraphics::StructToString::getCpuAccessFlagFromIndex
static CPU_ACCESS_FLAG getCpuAccessFlagFromIndex(unsigned int index)
nkGraphics::StructToString::getStringStencilOp
static STENCIL_OP getStringStencilOp(const nkMemory::StringView &str)
nkGraphics::StructToString::getTexRenderFlagString
static nkMemory::StringView getTexRenderFlagString(TEX_RENDER_FLAG val)
nkGraphics::StructToString::getBlendOpFromIndex
static BLEND_OP getBlendOpFromIndex(unsigned int index)
nkGraphics::StructToString::getBlendFromIndex
static BLEND getBlendFromIndex(unsigned int index)
nkGraphics::StructToString::getProgramProfileString
static nkMemory::StringView getProgramProfileString(PROGRAM_COMPILATION_PROFILE val)
nkGraphics::StructToString::getStringCpuAccessFlag
static CPU_ACCESS_FLAG getStringCpuAccessFlag(const nkMemory::StringView &str)
nkGraphics::StructToString::getFillModeFromIndex
static FILL_MODE getFillModeFromIndex(unsigned int index)
nkGraphics::StructToString::getCullModeFromIndex
static CULL_MODE getCullModeFromIndex(unsigned int index)
nkGraphics::StructToString::getStringBlendOp
static BLEND_OP getStringBlendOp(const nkMemory::StringView &str)
nkGraphics::StructToString::getAddressModeFromIndex
static TEXTURE_ADDRESS_MODE getAddressModeFromIndex(unsigned int index)
nkGraphics::DEPTH_WRITE_MASK
DEPTH_WRITE_MASK
Available depth write masks.
Definition: DxDefinesWrapper.h:266
nkGraphics::StructToString::getDepthWriteMaskString
static nkMemory::StringView getDepthWriteMaskString(DEPTH_WRITE_MASK val)
nkGraphics::StructToString::getStringAddressMode
static TEXTURE_ADDRESS_MODE getStringAddressMode(const nkMemory::StringView &str)
nkGraphics::USAGE
USAGE
Available usage for resources. Drives the memory used for hosting the data.
Definition: DxDefinesWrapper.h:13
nkGraphics::StructToString::getAddressModeString
static nkMemory::StringView getAddressModeString(TEXTURE_ADDRESS_MODE val)
nkGraphics::StructToString::getWriteMaskFromIndex
static COLOR_WRITE_ENABLE getWriteMaskFromIndex(unsigned int index)
nkGraphics::StructToString::getMiscFlagFromIndex
static RESOURCE_MISC_FLAG getMiscFlagFromIndex(unsigned int index)
nkGraphics::COLOR_WRITE_ENABLE
COLOR_WRITE_ENABLE
Available color write masks.
Definition: DxDefinesWrapper.h:427
nkGraphics::BLEND
BLEND
Available blending types.
Definition: DxDefinesWrapper.h:389
nkGraphics::StructToString::getStencilOpString
static nkMemory::StringView getStencilOpString(STENCIL_OP val)
nkGraphics::StructToString::getBlendString
static const char * getBlendString(BLEND val)
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::StructToString::getMiscFlagString
static nkMemory::StringView getMiscFlagString(RESOURCE_MISC_FLAG val)
nkGraphics::PASS_TYPE
PASS_TYPE
The pass types available in the component.
Definition: PassType.h:12
nkGraphics::StructToString::getStringCullMode
static CULL_MODE getStringCullMode(const nkMemory::StringView &str)
nkGraphics::StructToString::getUsageFromIndex
static USAGE getUsageFromIndex(unsigned int index)
nkGraphics::StructToString::getShaderSemanticString
static nkMemory::StringView getShaderSemanticString(SHADER_SEMANTIC val)
nkGraphics::CPU_ACCESS_FLAG
CPU_ACCESS_FLAG
Available cpu access flags.
Definition: DxDefinesWrapper.h:44
nkGraphics::StructToString::getComparisonFuncString
static nkMemory::StringView getComparisonFuncString(COMPARISON_FUNC val)
nkGraphics::StructToString::getUsageString
static nkMemory::StringView getUsageString(USAGE val)
nkGraphics::StructToString::getStringMiscFlag
static RESOURCE_MISC_FLAG getStringMiscFlag(const nkMemory::StringView &str)
nkGraphics::TEXTURE_ADDRESS_MODE
TEXTURE_ADDRESS_MODE
Available texture addressing modes available for samplers.
Definition: DxDefinesWrapper.h:126
nkGraphics::StructToString::getFilteringFromIndex
static FILTER getFilteringFromIndex(unsigned int index)
nkGraphics::StructToString::getStringBindFlag
static BIND_FLAG getStringBindFlag(const nkMemory::StringView &str)
nkGraphics::FILTER
FILTER
Available filters available for samplers.
Definition: DxDefinesWrapper.h:82
nkGraphics::StructToString::getStringFillMode
static FILL_MODE getStringFillMode(const nkMemory::StringView &str)
nkGraphics::SHADER_SEMANTIC
SHADER_SEMANTIC
Available shader semantics.
Definition: DxDefinesWrapper.h:477
nkGraphics::COMPARISON_FUNC
COMPARISON_FUNC
Available comparison functions.
Definition: DxDefinesWrapper.h:139
nkGraphics::STENCIL_OP
STENCIL_OP
Available stencil operations.
Definition: DxDefinesWrapper.h:276
nkGraphics::FORMAT
FORMAT
Available formats for resources.
Definition: DxDefinesWrapper.h:155
nkGraphics::StructToString::getFormatFromIndex
static FORMAT getFormatFromIndex(unsigned int index)
nkGraphics::FILL_MODE
FILL_MODE
Available filling mode during rasterization.
Definition: DxDefinesWrapper.h:440
nkGraphics::StructToString::getStringFiltering
static FILTER getStringFiltering(const nkMemory::StringView &str)
nkGraphics::StructToString::getBindFlagFromIndex
static BIND_FLAG getBindFlagFromIndex(unsigned int index)
nkGraphics::StructToString::getStringShaderSemantic
static SHADER_SEMANTIC getStringShaderSemantic(const nkMemory::StringView &str)
nkGraphics::PROGRAM_COMPILATION_PROFILE
PROGRAM_COMPILATION_PROFILE
Available program compilation profiles.
Definition: DxDefinesWrapper.h:602
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::StructToString::getStringTexRenderFlag
static TEX_RENDER_FLAG getStringTexRenderFlag(const nkMemory::StringView &str)
nkGraphics::StructToString::getCpuAccessFlagString
static nkMemory::StringView getCpuAccessFlagString(CPU_ACCESS_FLAG val)
nkGraphics::StructToString::getFillModeString
static nkMemory::StringView getFillModeString(FILL_MODE val)
nkGraphics::TEX_RENDER_FLAG
TEX_RENDER_FLAG
The render flag possible for a texture.
Definition: Texture.h:22
nkGraphics::StructToString::getStringDepthWriteMask
static DEPTH_WRITE_MASK getStringDepthWriteMask(const nkMemory::StringView &str)
nkGraphics::StructToString::getWriteMaskString
static nkMemory::StringView getWriteMaskString(COLOR_WRITE_ENABLE val)
nkGraphics::StructToString::getFilteringString
static nkMemory::StringView getFilteringString(FILTER val)
nkGraphics::StructToString::getStringFormat
static FORMAT getStringFormat(const nkMemory::StringView &str)